Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure README.md #126

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Restructure README.md #126

merged 1 commit into from
Sep 27, 2023

Conversation

rajveer43
Copy link
Contributor

@rajveer43 rajveer43 commented Sep 21, 2023

Fixes #105

Proposed Changes

  • Addition of Table of Contents
  • Using Precise Language

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@zkoppert zkoppert added the documentation Improvements or additions to documentation label Sep 21, 2023
@zkoppert
Copy link
Member

Thanks for adding a table of contents with great descriptions! I appreciate you taking the time to contribute. Would you like to keep this PR open and work with @MihirKohli to make any other readability changes to the README or merge this through and open a new PR for any other changes?

Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like @MihirKohli opened a separate pull request so I will merge this one through. Thanks for adding this! 🚀

@zkoppert zkoppert merged commit b1d72a5 into github:main Sep 27, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README is really long
2 participants